[LG-5587] fix(text-input): ref type missing #3167
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
kraenhansen
force-pushed
the
kh/text-input-ref
branch
from
79287fd to
66ace9f
Compare
kraenhansen
requested review from
Copilot and
stephl3
and removed request for
a team
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a TypeScript issue where the TextInput component was not properly accepting ref props due to incorrect type definitions. The fix ensures that React refs work correctly with the TextInput component.
- Updated
BaseTextInputPropsto useReact.ComponentPropsWithRefinstead ofReact.ComponentPropsWithoutRef - Simplified the component type definition by removing the exported
TextInputComponentTypeand defining it inline - Added test coverage to verify that both
TextInputandTextAreacomponents properly accept refs
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/text-input/src/TextInput/TextInput.types.ts | Changed base props interface to support refs and removed exported component type |
| packages/text-input/src/TextInput/TextInput.tsx | Updated component typing to use inline type definition instead of exported type |
| packages/text-input/src/TextInput/TextInput.spec.tsx | Added test to verify TextInput accepts HTMLInputElement refs |
| packages/text-area/src/TextArea/TextArea.spec.tsx | Added test to verify TextArea accepts HTMLTextAreaElement refs |
|
Size Change: 0 B Total Size: 1.59 MB ℹ️ View Unchanged
|
|
Closing in favor of #3197 |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
The test showed how the
TextInputcould no longer take aref.I suggest fixing this by adopting a pattern already used in
TextArea(using `` to declareComponentPropsWithRef).As a drive-by I also aligned the
TextInputwithTextAreaby moving the component type declaration out of the.types.tsfile and declare theconstexport instead of using a type assertion, for a stronger guarantees.🎟 Jira ticket: LG-5587
✅ Checklist
For new components
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes